Document how to support camelcase attributes #417
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Generally, this commit adds documentation to the `ActiveResource::Base` class-level and method-level documentation to explain how attribute loading and encoding works. In addition, test coverage is added for camelcase-based attribute loading and encoding. Code samples are added to method-level documentation to more clearly communicate how support can be added at the application level.
seanpdoyle
commented
Jan 5, 2025
Comment on lines
+19
to
+27
| def load(attributes, *args) | ||
| attributes = attributes.deep_transform_keys { |key| key.to_s.underscore } | ||
|
|
||
| super | ||
| end | ||
|
|
||
| def serializable_hash(options = {}) | ||
| super.deep_transform_keys! { |key| key.camelcase(:lower) } | ||
| end |
There was a problem hiding this comment.
Is this the best way to achieve this outcome? When learning about the library, my first instinct was to tackle name casing at the JsonFormat level.
Unfortunately, since #encode is implemented in terms of #to_json, and not JsonFormat.encode, a custom format that inherited from JsonFormat had no effect.
Is there a more canonical way to extend or configure the pre-existing JsonFormat module to more elegantly handle this?
Could it be worthwhile to explore changing the Base#encode implementation to incorporate self.class.format.encode?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Generally, this commit adds documentation to the
ActiveResource::Baseclass-level and method-level documentation to explain how attribute loading and encoding works.In addition, test coverage is added for camelcase-based attribute loading and encoding. Code samples are added to method-level documentation to more clearly communicate how support can be added at the application level.